home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / gnu / bash / bash_108 / bash-108.zoo / bash-1.08 / readline / doc / history.info < prev    next >
Encoding:
Text File  |  1991-05-01  |  17.5 KB  |  519 lines
  1. Info file history.info, produced by Makeinfo, -*- Text -*- from input
  2. file hist.texinfo.
  3.  
  4.    This document describes the GNU History library, a programming
  5. tool that provides a consistent user interface for recalling lines
  6. of previously typed input.
  7.  
  8.    Copyright (C) 1988, 1991 Free Software Foundation, Inc.
  9.  
  10.    Permission is granted to make and distribute verbatim copies of
  11. this manual provided the copyright notice and this permission notice
  12. pare preserved on all copies.
  13.  
  14.    Permission is granted to copy and distribute modified versions of
  15. this manual under the conditions for verbatim copying, provided that
  16. the entire resulting derived work is distributed under the terms of
  17. a permission notice identical to this one.
  18.  
  19.    Permission is granted to copy and distribute translations of this
  20. manual into another language, under the above conditions for
  21. modified versions, except that this permission notice may be stated
  22. in a translation approved by the Foundation.
  23.  
  25. File: history.info,  Node: Top,  Next: Using History Interactively,  Prev: (DIR),  Up: (DIR)
  26.  
  27. GNU History Library
  28. *******************
  29.  
  30.    This document describes the GNU History library, a programming
  31. tool that provides a consistent user interface for recalling lines
  32. of previously typed input.
  33.  
  34. * Menu:
  35.  
  36. * Using History Interactively::      GNU History User's Manual.
  37. * Programming with GNU History::  GNU History Programmer's Manual.
  38. * Concept Index::          Index of concepts described in this manual.
  39. * Function and Variable Index::      Index of externally visible functions
  40.                   and variables.
  41.  
  43. File: history.info,  Node: Using History Interactively,  Next: Programming with GNU History,  Prev: Top,  Up: Top
  44.  
  45. Using History Interactively
  46. ***************************
  47.  
  48.    This chapter describes how to use the GNU History Library
  49. interactively, from a user's standpoint.  It should be considered a
  50. user's guide.  For information on using the GNU History Library in
  51. your own programs, *note Programming with GNU History::..
  52.  
  53. * Menu:
  54.  
  55. * History Interaction::        What it feels like using History as a user.
  56.  
  58. File: history.info,  Node: History Interaction,  Up: Using History Interactively
  59.  
  60. History Interaction
  61. ===================
  62.  
  63.    The History library provides a history expansion feature that is
  64. similar to the history expansion in Csh.  The following text
  65. describes the sytax that you use to manipulate the history
  66. information.
  67.  
  68.    History expansion takes place in two parts.  The first is to
  69. determine which line from the previous history should be used during
  70. substitution.  The second is to select portions of that line for
  71. inclusion into the current one.  The line selected from the previous
  72. history is called the "event", and the portions of that line that
  73. are acted upon are called "words".  The line is broken into words
  74. in the same fashion that the Bash shell does, so that several
  75. English (or Unix) words surrounded by quotes are considered as one
  76. word.
  77.  
  78. * Menu:
  79.  
  80. * Event Designators::    How to specify which history line to use.
  81. * Word Designators::    Specifying which words are of interest.
  82. * Modifiers::        Modifying the results of susbstitution.
  83.  
  85. File: history.info,  Node: Event Designators,  Next: Word Designators,  Up: History Interaction
  86.  
  87. Event Designators
  88. -----------------
  89.  
  90.    An event designator is a reference to a command line entry in the
  91. history list.
  92.  
  93. `!'
  94.      Start a history subsititution, except when followed by a space,
  95.      tab, or the end of the line... = or (.
  96.  
  97. `!!'
  98.      Refer to the previous command.  This is a synonym for `!-1'.
  99.  
  100. `!n'
  101.      Refer to command line N.
  102.  
  103. `!-n'
  104.      Refer to the command line N lines back.
  105.  
  106. `!string'
  107.      Refer to the most recent command starting with STRING.
  108.  
  109. `!?string'[`?']
  110.      Refer to the most recent command containing STRING.
  111.  
  113. File: history.info,  Node: Word Designators,  Next: Modifiers,  Prev: Event Designators,  Up: History Interaction
  114.  
  115. Word Designators
  116. ----------------
  117.  
  118.    A : separates the event specification from the word designator. 
  119. It can be omitted if the word designator begins with a ^, $, * or %.
  120. Words are numbered from the beginning of the line, with the first
  121. word being denoted by a 0 (zero).
  122.  
  123. `0 (zero)'
  124.      The zero'th word.  For many applications, this is the command
  125.      word.
  126.  
  127. `n'
  128.      The N'th word.
  129.  
  130. `^'
  131.      The first argument.  that is, word 1.
  132.  
  133. `$'
  134.      The last argument.
  135.  
  136. `%'
  137.      The word matched by the most recent `?string?' search.
  138.  
  139. `x-y'
  140.      A range of words; `-Y' Abbreviates `0-Y'.
  141.  
  142. `*'
  143.      All of the words, excepting the zero'th.  This is a synonym for
  144.      `1-$'.  It is not an error to use * if there is just one word
  145.      in the event.  The empty string is returned in that case.
  146.  
  148. File: history.info,  Node: Modifiers,  Prev: Word Designators,  Up: History Interaction
  149.  
  150. Modifiers
  151. ---------
  152.  
  153.    After the optional word designator, you can add a sequence of one
  154. or more of the following modifiers, each preceded by a :.
  155.  
  156. `#'
  157.      The entire command line typed so far.  This means the current
  158.      command, not the previous command, so it really isn't a word
  159.      designator, and doesn't belong in this section.
  160.  
  161. `h'
  162.      Remove a trailing pathname component, leaving only the head.
  163.  
  164. `r'
  165.      Remove a trailing suffix of the form `.'SUFFIX, leaving the
  166.      basename.
  167.  
  168. `e'
  169.      Remove all but the suffix.
  170.  
  171. `t'
  172.      Remove all leading  pathname  components, leaving the tail.
  173.  
  174. `p'
  175.      Print the new command but do not execute it.
  176.  
  178. File: history.info,  Node: Programming with GNU History,  Next: Concept Index,  Prev: Using History Interactively,  Up: Top
  179.  
  180. Programming with GNU History
  181. ****************************
  182.  
  183.    This chapter describes how to interface the GNU History Library
  184. with programs that you write.  It should be considered a technical
  185. guide.  For information on the interactive use of GNU History, *note
  186. Using History Interactively::..
  187.  
  188. * Menu:
  189.  
  190. * Introduction to History::    What is the GNU History library for?
  191. * History Storage::        How information is stored.
  192. * History Functions::        Functions that you can use.
  193. * History Variables::        Variables that control behaviour.
  194. * History Programming Example::    Example of using the GNU History Library.
  195.  
  197. File: history.info,  Node: Introduction to History,  Next: History Storage,  Up: Programming with GNU History
  198.  
  199. Introduction to History
  200. =======================
  201.  
  202.    Many programs read input from the user a line at a time.  The GNU
  203. history library is able to keep track of those lines, associate
  204. arbitrary data with each line, and utilize information from previous
  205. lines in making up new ones.
  206.  
  207.    The programmer using the History library has available to him
  208. functions for remembering lines on a history stack, associating
  209. arbitrary data with a line, removing lines from the stack, searching
  210. through the stack for a line containing an arbitrary text string,
  211. and referencing any line on the stack directly.  In addition, a
  212. history "expansion" function is available which provides for a
  213. consistent
  214. user interface across many different programs.
  215.  
  216.    The end-user using programs written with the History library has
  217. the benifit of a consistent user interface, with a set of well-known
  218. commands for manipulating the text of previous lines and using that
  219. text in new commands.  The basic history manipulation commands are
  220. similar to the history substitution used by `Csh'.
  221.  
  222.    If the programmer desires, he can use the Readline library, which
  223. includes some history manipulation by default, and has the added
  224. advantage of Emacs style command line editing.
  225.  
  227. File: history.info,  Node: History Storage,  Next: History Functions,  Prev: Introduction to History,  Up: Programming with GNU History
  228.  
  229. History Storage
  230. ===============
  231.  
  232.      typedef struct _hist_entry {
  233.        char *line;
  234.        char *data;
  235.      } HIST_ENTRY;
  236.  
  238. File: history.info,  Node: History Functions,  Next: History Variables,  Prev: History Storage,  Up: Programming with GNU History
  239.  
  240. History Functions
  241. =================
  242.  
  243.    This section describes the calling sequence for the various
  244. functions present in GNU History.
  245.  
  246.  * Function: void using_history ()
  247.      Begin a session in which the history functions might be used. 
  248.      This just initializes the interactive variables.
  249.  
  250.  * Function: void add_history (CHAR *STRING)
  251.      Place STRING at the end of the history list.  The associated
  252.      data field (if any) is set to `NULL'.
  253.  
  254.  * Function: int where_history ()
  255.      Returns the number which says what history element we are now
  256.      looking at.
  257.  
  258.  * Function: int history_set_pos (INT POS)
  259.      Set the position in the history list to POS.
  260.  
  261.  * Function: int history_search_pos (CHAR *STRING, INT DIRECTION, INT
  262.           POS)
  263.      Search for STRING in the history list, starting at POS, an
  264.      absolute index into the list.  DIRECTION, if negative, says to
  265.      search backwards from POS, else forwards.  Returns the absolute
  266.      index of the history element where STRING was found, or -1
  267.      otherwise.
  268.  
  269.  * Function: HIST_ENTRY *remove_history ();
  270.      Remove history element WHICH from the history.  The removed
  271.      element is returned to you so you can free the line, data, and
  272.      containing structure.
  273.  
  274.  * Function: void stifle_history (INT MAX)
  275.      Stifle the history list, remembering only MAX number of entries.
  276.  
  277.  * Function: int unstifle_history ();
  278.      Stop stifling the history.  This returns the previous amount the
  279.      history was stifled by.  The value is positive if the history
  280.      was stifled, negative if it wasn't.
  281.  
  282.  * Function: int read_history (CHAR *FILENAME)
  283.      Add the contents of FILENAME to the history list, a line at a
  284.      time.  If FILENAME is `NULL', then read from `~/.history'. 
  285.      Returns 0 if successful, or errno if not.
  286.  
  287.  * Function: int read_history_range (CHAR *FILENAME, INT FROM, INT TO)
  288.      Read a range of lines from FILENAME, adding them to the history
  289.      list.  Start reading at the FROM'th line and end at the TO'th. 
  290.      If FROM is zero, start at the beginning.  If TO is less than
  291.      FROM, then read until the end of the file.  If FILENAME is
  292.      `NULL', then read from `~/.history'.  Returns 0 if successful,
  293.      or `errno' if not.
  294.  
  295.  * Function: int write_history (CHAR *FILENAME)
  296.      Append the current history to FILENAME.  If FILENAME is `NULL',
  297.      then append the history list to `~/.history'.  Values returned
  298.      are as in `read_history ()'.
  299.  
  300.  * Function: int append_history (INT NELEMENTS, CHAR *FILENAME)
  301.      Append NELEMENT entries to FILENAME.  The entries appended are
  302.      from the end of the list minus NELEMENTS up to the end of the
  303.      list.
  304.  
  305.  * Function: HIST_ENTRY *replace_history_entry ()
  306.      Make the history entry at WHICH have LINE and DATA.  This
  307.      returns the old entry so you can dispose of the data.  In the
  308.      case of an invalid WHICH, a `NULL' pointer is returned.
  309.  
  310.  * Function: HIST_ENTRY *current_history ()
  311.      Return the history entry at the current position, as determined
  312.      by `history_offset'.  If there is no entry there, return a
  313.      `NULL' pointer.
  314.  
  315.  * Function: HIST_ENTRY *previous_history ()
  316.      Back up HISTORY_OFFSET to the previous history entry, and return
  317.      a pointer to that entry.  If there is no previous entry, return
  318.      a `NULL' pointer.
  319.  
  320.  * Function: HIST_ENTRY *next_history ()
  321.      Move `history_offset' forward to the next history entry, and
  322.      return the a pointer to that entry.  If there is no next entry,
  323.      return a `NULL' pointer.
  324.  
  325.  * Function: HIST_ENTRY **history_list ()
  326.      Return a `NULL' terminated array of `HIST_ENTRY' which is the
  327.      current input history.  Element 0 of this list is the beginning
  328.      of time.  If there is no history, return `NULL'.
  329.  
  330.  * Function: int history_search (CHAR *STRING, INT DIRECTION)
  331.      Search the history for STRING, starting at `history_offset'.  If
  332.      DIRECTION < 0, then the search is through previous entries,
  333.      else through subsequent.  If STRING is found, then
  334.      `current_history ()' is the history entry, and the value of
  335.      this function is the offset in the line of that history entry
  336.      that the STRING was found in.  Otherwise, nothing is changed,
  337.      and a -1 is returned.
  338.  
  339.  * Function: int history_expand (CHAR *STRING, CHAR **OUTPUT)
  340.      Expand STRING, placing the result into OUTPUT, a pointer to a
  341.      string.  Returns:
  342.  
  343.     `0'
  344.           If no expansions took place (or, if the only change in the
  345.           text was the de-slashifying of the history expansion
  346.           character),
  347.  
  348.     `1'
  349.           if expansions did take place, or
  350.  
  351.     `-1'
  352.           if there was an error in expansion.
  353.  
  354.      If an error ocurred in expansion, then OUTPUT contains a
  355.      descriptive error message.
  356.  
  357.  * Function: char *history_arg_extract (INT FIRST, INT LAST, CHAR
  358.           *STRING)
  359.      Extract a string segment consisting of the FIRST through LAST
  360.      arguments present in STRING.  Arguments are broken up as in the
  361.      GNU Bash shell.
  362.  
  363.  * Function: int history_total_bytes ();
  364.      Return the number of bytes that the primary history entries are
  365.      using.  This just adds up the lengths of `the_history->lines'.
  366.  
  368. File: history.info,  Node: History Variables,  Next: History Programming Example,  Prev: History Functions,  Up: Programming with GNU History
  369.  
  370. History Variables
  371. =================
  372.  
  373.    This section describes the variables in GNU History that are
  374. externally visible.
  375.  
  376.  * Variable: int history_base
  377.      For convenience only.  You set this when interpreting history
  378.      commands.  It is the logical offset of the first history element.
  379.  
  381. File: history.info,  Node: History Programming Example,  Prev: History Variables,  Up: Programming with GNU History
  382.  
  383. History Programming Example
  384. ===========================
  385.  
  386.    The following snippet of code demonstrates simple use of the GNU
  387. History Library.
  388.  
  389.      main ()
  390.      {
  391.        char line[1024], *t;
  392.        int done = 0;
  393.      
  394.        line[0] = 0;
  395.      
  396.        while (!done)
  397.          {
  398.            fprintf (stdout, "history%% ");
  399.            t = gets (line);
  400.      
  401.            if (!t)
  402.              strcpy (line, "quit");
  403.      
  404.            if (line[0])
  405.              {
  406.                char *expansion;
  407.                int result;
  408.      
  409.                using_history ();
  410.      
  411.                result = history_expand (line, &expansion);
  412.                strcpy (line, expansion);
  413.                free (expansion);
  414.                if (result)
  415.                  fprintf (stderr, "%s\n", line);
  416.      
  417.                if (result < 0)
  418.                  continue;
  419.      
  420.                add_history (line);
  421.              }
  422.      
  423.            if (strcmp (line, "quit") == 0) done = 1;
  424.            if (strcmp (line, "save") == 0) write_history (0);
  425.            if (strcmp (line, "read") == 0) read_history (0);
  426.            if (strcmp (line, "list") == 0)
  427.              {
  428.                register HIST_ENTRY **the_list = history_list ();
  429.                register int i;
  430.      
  431.                if (the_list)
  432.                  for (i = 0; the_list[i]; i++)
  433.                    fprintf (stdout, "%d: %s\n",
  434.                       i + history_base, the_list[i]->line);
  435.              }
  436.            if (strncmp (line, "delete", strlen ("delete")) == 0)
  437.              {
  438.                int which;
  439.                if ((sscanf (line + strlen ("delete"), "%d", &which)) == 1)
  440.                  {
  441.                    HIST_ENTRY *entry = remove_history (which);
  442.                    if (!entry)
  443.                      fprintf (stderr, "No such entry %d\n", which);
  444.                    else
  445.                      {
  446.                        free (entry->line);
  447.                        free (entry);
  448.                      }
  449.                  }
  450.                else
  451.                  {
  452.                    fprintf (stderr, "non-numeric arg given to `delete'\n");
  453.                  }
  454.              }
  455.          }
  456.      }
  457.  
  459. File: history.info,  Node: Concept Index,  Next: Function and Variable Index,  Prev: Programming with GNU History,  Up: Top
  460.  
  461. Concept Index
  462. *************
  463.  
  464. * Menu:
  465.  
  466. * event designators:                    Event Designators.
  467. * expansion:                            History Interaction.
  468.  
  470. File: history.info,  Node: Function and Variable Index,  Prev: Concept Index,  Up: Top
  471.  
  472. Function and Variable Index
  473. ***************************
  474.  
  475. * Menu:
  476.  
  477. * HIST_ENTRY **history_list:            History Functions.
  478. * HIST_ENTRY *current_history:          History Functions.
  479. * HIST_ENTRY *next_history:             History Functions.
  480. * HIST_ENTRY *previous_history:         History Functions.
  481. * HIST_ENTRY *remove_history:           History Functions.
  482. * HIST_ENTRY *replace_history_entry:    History Functions.
  483. * char *history_arg_extract:            History Functions.
  484. * int append_history:                   History Functions.
  485. * int history_base:                     History Variables.
  486. * int history_expand:                   History Functions.
  487. * int history_search:                   History Functions.
  488. * int history_search_pos:               History Functions.
  489. * int history_set_pos:                  History Functions.
  490. * int history_total_bytes:              History Functions.
  491. * int read_history:                     History Functions.
  492. * int read_history_range:               History Functions.
  493. * int unstifle_history:                 History Functions.
  494. * int where_history:                    History Functions.
  495. * int write_history:                    History Functions.
  496. * void add_history:                     History Functions.
  497. * void stifle_history:                  History Functions.
  498. * void using_history:                   History Functions.
  499.  
  500.  
  502. Tag Table:
  503. Node: Top973
  504. Node: Using History Interactively1567
  505. Node: History Interaction2075
  506. Node: Event Designators3127
  507. Node: Word Designators3770
  508. Node: Modifiers4675
  509. Node: Programming with GNU History5424
  510. Node: Introduction to History6151
  511. Node: History Storage7501
  512. Node: History Functions7765
  513. Node: History Variables13062
  514. Node: History Programming Example13498
  515. Node: Concept Index15743
  516. Node: Function and Variable Index16029
  518. End Tag Table
  519.